DRYD-1832: New API Usage #279

mikejritter · 2025-07-31T19:37:26Z

What does this do?

Use the new search API when querying
Use the new search list when required
Display thumbnails for grid and detail views
Replace getListType helper with two alternatives:
- deriveSearchType which gets both the list type and search type (default, advanced)
- getListTypeFromResult which reads the search result in order to match against the configured list types
CSS adjustments for grid and detail views

Why are we doing this? (with JIRA link)
Jira: https://collectionspace.atlassian.net/browse/DRYD-1832

This allows us to query against the new API and test what the views look like with the new response data. In addition it has updated the grid and detail list views to incorporate the thumbnail of an object when possible. There's still work around those views which will need to be done, such as displaying an image if it is not found or providing a warning for NAGPRA related media.

Additional changes were made to deal with passing the listType as a prop everything. I found that as I was testing different functionality, either the search action was being called incorrectly or something else would happen because the listType and potentially the isNewSearch flag were incorrect. I opted to refactor a little bit and allow us to get the listType from either the searchDescriptor or the searchResult so that the listType/isNewSearch props aren't as necessary and can be omitted. Most of this work was done in e2891ae and tests were updated in 4548504.

How should this be tested? Do these changes have associated tests?
To test locally:

Ensure all tests are passing
- npm run lint
- npm run test
Rebuild collectionspace off of the develop branch, e.g.

sdk use java 8.0.362-amzn
cd ./services
mvn clean install -Dmaven.test.skip=true
cd ../application
mvn clean install -Dmaven.test.skip=true
cd ../services
ant undeploy deploy create_db import

Start your Tomcat server which collectionspace is deployed in
Run the devserver: npm run devserver
Navigate to the cspace interface and check
- That the main search interface is working
  - Navigation works when clicking on rows
  - The SearchResultTraveserver works when navigating in the record editor after clicking on a row
  - For objects specifically: The grid/list displays work and pull new data as expected
- In the record editor:
  - Each of the panels is able to be populated (Media, Terms Used, Related Objects/Procedures, Used By (authority only))
  - Each of the actions for a panel (open/add) can be used
- Elsewhere:
  - The Administration > Users page can be \used
  - The Administration > Roles and Permissions page can be used

Once the 403 issue with dev is resolved, instead of deploying locally this can be validated by using npm run devserver --back-end=https://core.dev.collectionspace.org

Dependencies for merging? Releasing to production?
The only thing I can think of is that it would be nice to have the tests use the same configuration as the application does when it starts up. I have work for that in another branch, which hopefully can be shared soon.

Has the application documentation been updated for these changes?
No

Did someone actually run this code to verify it works?
@mikejritter has only tested locally

This requires some prop drilling to work correctly, it would be nice find a better way to handle this

…rived list type

spirosdi · 2025-09-03T14:23:23Z

Doing a QA check, I have found the following issue:
Grid View: Paginating leads to uncaught errors and white page.
Steps to reproduce:
a. Search for a query with multiple pages result
b. Switch to grid view and click page 2 button in the pagination
c. This results in a white page and the following console errors:

searchResultHelpers.js:85 Uncaught TypeError: Cannot read properties of undefined (reading 'get')
    at readListItems (searchResultHelpers.js:85:29)
    at SearchResultGrid (SearchResultGrid.jsx:107:84)
    at renderWithHooks (react-dom.development.js:14803:18)
    at updateFunctionComponent (react-dom.development.js:17034:20)
    at beginWork (react-dom.development.js:18610:16)
    at HTMLUnknownElement.callCallback (react-dom.development.js:188:14)
    at Object.invokeGuardedCallbackDev (react-dom.development.js:237:16)
    at invokeGuardedCallback (react-dom.development.js:292:31)
    at beginWork$1 (react-dom.development.js:23203:7)
    at performUnitOfWork (react-dom.development.js:22154:12)

hook.js:608 The above error occurred in the <SearchResultGrid> component:
    in SearchResultGrid (created by InjectIntl(SearchResultGrid))
    in InjectIntl(SearchResultGrid) (created by SearchResults)
    in div (created by SearchResults)
    in div (created by SearchResults)
    in div (created by SearchResults)
    in SearchResults (created by SearchResultRoute)
    in SearchResultRoute (created by Context.Consumer)
    in div (created by ProtectedPage)
    in ProtectedPage (created by Context.Consumer)
    in Route (created by ProtectedRoute)
    in ProtectedRoute (created by Connect(ProtectedRoute))
    in Connect(ProtectedRoute) (created by RootPage)
    in Switch (created by RootPage)
    in div (created by RootPage)
    in RootPage (created by InjectIntl(RootPage))
    in InjectIntl(RootPage) (created by WithClassName)
    in WithClassName (created by Context.Consumer)
    in Route (created by App)
    in Switch (created by App)
    in Router (created by BrowserRouter)
    in BrowserRouter (created by App)
    in ConfigProvider (created by App)
    in Provider (created by App)
    in IntlProvider (created by App)
    in App (created by Connect(App))
    in Connect(App)

Consider adding an error boundary to your tree to customize error handling behavior.
Visit https://fb.me/react-error-boundaries to learn more about error boundaries.
react-dom.development.js:11102 Uncaught TypeError: Cannot read properties of undefined (reading 'get')
    at readListItems (searchResultHelpers.js:85:29)
    at SearchResultGrid (SearchResultGrid.jsx:107:84)
    at renderWithHooks (react-dom.development.js:14803:18)
    at updateFunctionComponent (react-dom.development.js:17034:20)
    at beginWork (react-dom.development.js:18610:16)
    at HTMLUnknownElement.callCallback (react-dom.development.js:188:14)
    at Object.invokeGuardedCallbackDev (react-dom.development.js:237:16)
    at invokeGuardedCallback (react-dom.development.js:292:31)
    at beginWork$1 (react-dom.development.js:23203:7)
    at performUnitOfWork (react-dom.development.js:22154:12)

mikejritter · 2025-09-03T16:12:24Z

@spirosdi Thanks, I was still thinking about the best way to get the list-items out of the response and it looks like for the Grid/Detail List func I didn't add any null safety. I might have some time to update it today since it should be a quick update.

src/components/pages/SearchResultPage.jsx

src/components/record/RecordTitleBar.jsx

src/components/search/SearchPanel.jsx

test/helpers/providerHelpers.jsx

spirosdi · 2025-09-04T04:37:34Z

QA issue: The Traverser is not shown when navigating to the record editor after clicking the list item in the "grid" layout. It works fine in the "table".

src/components/search/searchResultHelpers.js

spirosdi · 2025-09-04T12:36:22Z

QA issue: The Traverser is not shown when navigating to the record editor after clicking the list item in the "grid" layout. It works fine in the "table".

Actually the issue is not related to the current updates. It already appears in development branch. The best is to fix it in another task and PR, in order not to bloat the current one. Here the task: https://collectionspace.atlassian.net/browse/DRYD-1890

spirosdi · 2025-09-24T12:04:55Z

@mikejritter , now that collectionspace/services#475 is merged, we can merge this one too, right? Please let me know if you need any help with resolving the merge conflicts

mikejritter · 2025-09-30T16:02:35Z

@spirosdi Yep, I checked yesterday and saw that the /advancedsearch endpoint is able to be used on dev. I'll go through the conflicts today and get the branch ready to be merged.

codecov · 2025-09-30T22:09:04Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (5fe10ea) to head (b598858).
⚠️ Report is 1 commits behind head on develop.

❌ Your project status has failed because the head coverage (0.00%) is below the target coverage (95.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@      Coverage Diff       @@
##   develop   #279   +/-   ##
==============================
==============================

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mikejritter added 9 commits August 18, 2025 11:59

Add some docs for search

6e0f7af

Use search list type and api

568d0e6

Update to retrieve errors/results via hooks

bcb1c99

Remove unused variables

619f3f5

Remove unused imports

44838e3

Use search list type as the default

8869b00

Remove todo

9ee7931

Route subresource queries to regular search page

98d0df3

Clean up some todos/comments

798fc5c

mikejritter force-pushed the dryd-1804-api branch from 11572f6 to 70c360c Compare August 26, 2025 15:29

mikejritter added 10 commits August 26, 2025 14:53

rm comment

5a1a9be

Simplify css

b765a80

Start on styling for thumbnails

e2eda6e

Fetch search results and errors in SearchResultSummary

76db459

Pass listType for correct traversal of search data

19da6ef

This requires some prop drilling to work correctly, it would be nice find a better way to handle this

Start work for adding thumbnails

b6487d7

Correct item location path

cd3b5c0

Move away from passing listType prop to using functions to get the de…

e2891ae

…rived list type

Update tests for listType change

4548504

Use searchName constants

b12df38

mikejritter force-pushed the dryd-1804-api branch from 70c360c to b12df38 Compare September 2, 2025 15:42

mikejritter added 9 commits September 2, 2025 10:16

Linting fixes

14aedbe

Check if searchDescriptor is not null

ca29985

Add tests for deriveListType and getListTypeForResult

667b1c9

s/For/From

f66c29b

Remove old getListType

d726311

Get list type from the search result in new components

f1b19c3

Remove some extraneous code/comments

e241554

Missed import and add key

2ea0a9e

Add comments

63df751

mikejritter marked this pull request as ready for review September 2, 2025 21:03

spirosdi self-requested a review September 3, 2025 04:24

Additional null handling

bf19447

spirosdi requested changes Sep 4, 2025

View reviewed changes

spirosdi reviewed Sep 4, 2025

View reviewed changes

src/components/search/searchResultHelpers.js Outdated Show resolved Hide resolved

mikejritter added 5 commits September 5, 2025 14:27

Remove unused props/function

5210fee

Remove unused render helper

229e65b

More null safety

08ead5f

Remove unused listType const and prop

a31f3a6

Use single function for reading search results

c475021

spirosdi self-requested a review September 8, 2025 13:41

spirosdi approved these changes Sep 8, 2025

View reviewed changes

mikejritter added 5 commits September 30, 2025 14:27

Merge branch 'develop' into dryd-1804-api

a4adedd

Re-add searchResults for toggle bar

6f0a373

Get list type from result

24c9eb2

Remove duplicate subtitle display from merge

561bee9

Remove extraneous comment

b598858

mikejritter merged commit ddf2587 into collectionspace:develop Sep 30, 2025
2 checks passed

mikejritter deleted the dryd-1804-api branch September 30, 2025 22:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DRYD-1832: New API Usage #279

DRYD-1832: New API Usage #279

Uh oh!

mikejritter commented Jul 31, 2025 •

edited

Loading

Uh oh!

spirosdi commented Sep 3, 2025

Uh oh!

mikejritter commented Sep 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

spirosdi commented Sep 4, 2025

Uh oh!

Uh oh!

spirosdi commented Sep 4, 2025 •

edited

Loading

Uh oh!

spirosdi commented Sep 24, 2025

Uh oh!

mikejritter commented Sep 30, 2025

Uh oh!

Uh oh!

codecov bot commented Sep 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

DRYD-1832: New API Usage #279

DRYD-1832: New API Usage #279

Uh oh!

Conversation

mikejritter commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

spirosdi commented Sep 3, 2025

Uh oh!

mikejritter commented Sep 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

spirosdi commented Sep 4, 2025

Uh oh!

Uh oh!

spirosdi commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

spirosdi commented Sep 24, 2025

Uh oh!

mikejritter commented Sep 30, 2025

Uh oh!

Uh oh!

codecov bot commented Sep 30, 2025

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mikejritter commented Jul 31, 2025 •

edited

Loading

spirosdi commented Sep 4, 2025 •

edited

Loading